Resource URL: /platform/<<version=1>>/storagepool/tiers/<TID>

    Overview: This resource applies the standard collection item pattern to
              individual OneFS storage pool tiers. TID in the resource path is
              either the tier name or tier ID.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve tier information.

       URL: GET /platform/<<version=1>>/storagepool/tiers/<TID>

There are no query arguments for this method.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "tiers": {
      "items": {
        "type": "object", 
        "properties": {
          "usage": {
            "required": true, 
            "type": "object", 
            "description": "Total pool usage.", 
            "properties": {
              "virtual_hot_spare_bytes": {
                "required": true, 
                "type": "string", 
                "description": "Bytes reserved for virtual hot spare in the pool."
              }, 
              "avail_bytes": {
                "required": true, 
                "type": "string", 
                "description": "Available free bytes remaining in the pool when virtual hot spare is taken into account."
              }, 
              "avail_ssd_bytes": {
                "required": true, 
                "type": "string", 
                "description": "Available free bytes remaining in the pool on SSD drives when virtual hot spare is taken into account."
              }, 
              "free_ssd_bytes": {
                "required": true, 
                "type": "string", 
                "description": "Free bytes remaining in the pool on SSD drives."
              }, 
              "free_bytes": {
                "required": true, 
                "type": "string", 
                "description": "Free bytes remaining in the pool."
              }, 
              "total_ssd_bytes": {
                "required": true, 
                "type": "string", 
                "description": "Total bytes used in the pool on SSD drives."
              }, 
              "total_bytes": {
                "required": true, 
                "type": "string", 
                "description": "Total bytes used in the pool."
              }, 
              "balanced": {
                "required": true, 
                "type": "boolean", 
                "description": "Whether or not the pool usage is currently balanced."
              }
            }
          }, 
          "lnns": {
            "items": {
              "type": "integer"
            }, 
            "required": true, 
            "type": "array", 
            "description": "The nodes that are part of this tier."
          }, 
          "children": {
            "items": {
              "type": [
                "string", 
                "integer"
              ]
            }, 
            "required": false, 
            "type": "array", 
            "description": "The names or IDs of the tier's children."
          }, 
          "name": {
            "required": true, 
            "type": "string", 
            "description": "The tier name."
          }, 
          "id": {
            "required": true, 
            "type": "integer", 
            "description": "The system ID given to the tier."
          }
        }
      }, 
      "type": "array"
    }
  }
}

********************************************************************************

Method PUT: Modify tier. All input fields are optional, but one or more must be
            supplied.

       URL: PUT /platform/<<version=1>>/storagepool/tiers/<TID>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "children": {
      "items": {
        "type": [
          "string", 
          "integer"
        ]
      }, 
      "type": "array", 
      "description": "The names or IDs of the tier's children."
    }, 
    "name": {
      "type": "string", 
      "description": "The tier name."
    }
  }
}

There is no response body for this method.

********************************************************************************

Method DELETE: Delete tier.

          URL: DELETE /platform/<<version=1>>/storagepool/tiers/<TID>

There are no query arguments for this method.

There is no response body for this method.
